/*
 * Copyright 2010 - 2011, The PLDesktop Development Team
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 */
#ifndef PLIITERATOR_H
#define PLIITERATOR_H

#include <exception/PLElementNotFoundException.h>

namespace PLSDK {

    /**
     * Base interface for a iterator.
     */
    template<typename T>
    class PLIIterator {
    public:
        /**
         * Have the object a next object.
         *
         * @param pos The current position.
         * @return true if a next object was there.
         */
        virtual plbool hasNext(pluint pos) = 0;
        /**
         * Have the object a previous object.
         *
         * @param pos The current position.
         * @return true if a previous object was there.
         */
        virtual plbool hasPrevious(pluint pos) = 0;
        /**
         * The next object of the vector.
         *
         * @param pos The current position.
         * @return The next element.
         */
        virtual T next(pluint pos) = 0;
        /**
         * The previous object of the vector.
         *
         * @param pos The current position.
         */
        virtual T previous(pluint pos) = 0;
        /**
         * Return the current object.
         *
         * @param pos The current position.
         * @return The object.
         */
        virtual T current(pluint pos) = 0;
        /**
         * Remove the element at the current position.
         *
         * @param pos The current position.
         */
        virtual void removeElement(pluint pos) = 0;
    };

}

#endif
